Updates an existing address
Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.
- application/json
Request Body array required
- bpna string required
A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.
- name string
The name of the address. This is not according to official registers but according to the name the sharing member chooses.
states object[] required
identifiers object[] required
physicalPostalAddress object required
alternativePostalAddress object
confidenceCriteria object required
- requestKey string required
- 200
- 400
The successfully updated records, possible errors are returned
- application/json
- Schema
- Example (from schema)
Schema
entities object[]
errors object[]
- errorCount int32
- entityCount int32
{
"entities": [
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": {
"technicalKey": "ACTIVE",
"name": "string"
}
}
],
"identifiers": [
{
"value": "string",
"type": {
"technicalKey": "string",
"name": "string"
}
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": {
"technicalKey": "UNDEFINED",
"name": "string"
},
"administrativeAreaLevel1": {
"countryCode": "UNDEFINED",
"regionCode": "string",
"regionName": "string"
},
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": {
"technicalKey": "UNDEFINED",
"name": "string"
},
"administrativeAreaLevel1": {
"countryCode": "UNDEFINED",
"regionCode": "string",
"regionName": "string"
},
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"bpnLegalEntity": "string",
"bpnSite": "string",
"isCatenaXMemberData": true,
"createdAt": "2024-07-15",
"updatedAt": "2024-07-15",
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"addressType": "LegalAndSiteMainAddress"
}
],
"errors": [
{
"errorCode": "AddressNotFound",
"message": "string",
"entityKey": "string"
}
],
"errorCount": 0,
"entityCount": 0
}
On malformed requests
PUT /v6/addresses
Request
Request
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'
curl -L -X PUT 'http://localhost:8080/v6/addresses' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '[
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-07-15",
"validTo": "2024-07-15",
"type": "ACTIVE"
}
],
"identifiers": [
{
"value": "string",
"type": "string"
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string",
"taxJurisdictionCode": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-07-15",
"nextConfidenceCheckAt": "2024-07-15",
"confidenceLevel": 0
},
"requestKey": "string"
}
]'